<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html" id="m-navbar-current">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>Namespaces</h1>
        <ul class="m-doc">
          <li class="m-doc-collapsible">
            <a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacebn.html" class="m-doc">bn</a> <span class="m-doc">Main Butano namespace.</span>
            <ul class="m-doc">
              <li>namespace <a href="namespacebn_1_1assert.html" class="m-doc">assert</a> <span class="m-doc">Assert related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1audio.html" class="m-doc">audio</a> <span class="m-doc">Audio related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1backdrop.html" class="m-doc">backdrop</a> <span class="m-doc">Backdrop related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1bg__maps.html" class="m-doc">bg_maps</a> <span class="m-doc">Background maps related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1bg__palettes.html" class="m-doc">bg_palettes</a> <span class="m-doc">Background color palettes related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1bg__tiles.html" class="m-doc">bg_tiles</a> <span class="m-doc">Background tiles related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1bgs.html" class="m-doc">bgs</a> <span class="m-doc">Backgrounds related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1bgs__mosaic.html" class="m-doc">bgs_mosaic</a> <span class="m-doc">Functions related with the mosaic applied to the backgrounds.</span></li>
              <li>namespace <a href="namespacebn_1_1blending.html" class="m-doc">blending</a> <span class="m-doc">Blending related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1cameras.html" class="m-doc">cameras</a> <span class="m-doc">Cameras related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1color__effect.html" class="m-doc">color_effect</a> <span class="m-doc">Color effects related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1colors.html" class="m-doc">colors</a> <span class="m-doc">Some constant colors from TONC.</span></li>
              <li>namespace <a href="namespacebn_1_1core.html" class="m-doc">core</a> <span class="m-doc">Core related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1display.html" class="m-doc">display</a> <span class="m-doc">Display related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1dmg__music.html" class="m-doc">dmg_music</a> <span class="m-doc">DMG music related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1green__swap.html" class="m-doc">green_swap</a> <span class="m-doc">When it is enabled, green intensity of each two screen pixels are exchanged.</span></li>
              <li>namespace <a href="namespacebn_1_1hbes.html" class="m-doc">hbes</a> <span class="m-doc">H-Blank effects related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1hdma.html" class="m-doc">hdma</a> <span class="m-doc">H-Blank direct memory access related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1jingle.html" class="m-doc">jingle</a> <span class="m-doc">Direct Sound jingles related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1keypad.html" class="m-doc">keypad</a> <span class="m-doc">Keypad related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1link.html" class="m-doc">link</a> <span class="m-doc">Link communication related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1memory.html" class="m-doc">memory</a> <span class="m-doc">Memory related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1music.html" class="m-doc">music</a> <span class="m-doc">Direct Sound music related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1profiler.html" class="m-doc">profiler</a> <span class="m-doc">Profiler related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1rumble.html" class="m-doc">rumble</a> <span class="m-doc">Rumble related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1sound.html" class="m-doc">sound</a> <span class="m-doc">Sound effects related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1sprite__affine__mats.html" class="m-doc">sprite_affine_mats</a> <span class="m-doc">Sprite affine transformation matrices related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1sprite__palettes.html" class="m-doc">sprite_palettes</a> <span class="m-doc">Sprite color palettes related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1sprite__tiles.html" class="m-doc">sprite_tiles</a> <span class="m-doc">Sprite tiles related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1sprites.html" class="m-doc">sprites</a> <span class="m-doc">Sprites related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1sprites__mosaic.html" class="m-doc">sprites_mosaic</a> <span class="m-doc">Functions related with the mosaic applied to the sprites.</span></li>
              <li>namespace <a href="namespacebn_1_1sram.html" class="m-doc">sram</a> <span class="m-doc">SRAM related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1timers.html" class="m-doc">timers</a> <span class="m-doc">Timing related functions.</span></li>
              <li>namespace <a href="namespacebn_1_1version.html" class="m-doc">version</a> <span class="m-doc">Current version of Butano.</span></li>
            </ul>
          </li>
        </ul>
        <script>
        function toggle(e) {
            e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
                'm-doc-expansible' : 'm-doc-collapsible';
            return false;
        }
        /* Collapse all nodes marked as such. Doing it via JS instead of
           directly in markup so disabling it doesn't harm usability. The list
           is somehow regenerated on every iteration and shrinks as I change
           the classes. It's not documented anywhere and I'm not sure if this
           is the same across browsers, so I am going backwards in that list to
           be sure. */
        var collapsed = document.getElementsByClassName("collapsed");
        for(var i = collapsed.length - 1; i >= 0; --i)
            collapsed[i].className = 'm-doc-expansible';
        </script>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
